﻿==============================================================================
===============                  Mission Loader                ===============
===============                   version 1.15                 ===============
===============                created by podvoxx              ===============
==============================================================================
        Pilot Training platform for "IL-2 Sturmovik: Cliffs of Dover"
==============================================================================
******************************************************************************


==============================================================================
   * Краткое описание *
______________________________________________________________________________
   Миссия предназначена для загрузки любых миссий прямо в игре через меню, вызываемое при помощи <"Tab" + "4">. Загрузчик работает в онлайн и оффлайн вариантах миссий, а также на выделенном сервере. При помощи загрузчика вы можете быстро загружать миссии и играть их, меняя самолет, вооружение и точки респауна.
   В сборку включены стандартные миссии, описание которых приведено в ридми миссион-пака.
   Если возникают затруднения с поиском цели (не все миссии имеют описание) воспользуйтесь маркерами на карте.


==============================================================================
   * Установка *
______________________________________________________________________________
   Внимание! Если у вас стояла предыдущая версия удалите папку "MissionLoader" старой версии предварительно сохранив свои миссии. После установки загрузчика скопируйте свои миссии обратно.

   1. Распаковать архив и скопировать полученный каталог "MissionLoader" в папку X:\...\Documents\1C SoftClub\il-2 sturmovik cliffs of dover\missions\ на вашем компьютере.

   2. После этого запустите файл миссии host-channel.mis и проверьте работу загрузчика. Для этого нажмите <"Tab"+"4"> и выберите любую миссию. Если возникают ошибки - проверьте правильность выполнения пункта 1.


==============================================================================
   * Настройка и использование *
______________________________________________________________________________
   1. Настройка названий пунктов меню. 
      Если вы не хотите, чтобы какие-нибудь папка или файл миссии отображались в меню - просто поставьте в начале имени файла или папки знак тире "-". После этого файл миссии или папка будут исключены из меню.
      
   2. Перезагрузка MissionLoader.
      Периодически перезагружайте миссию, чтобы очистить карту от разбитой техники и объектов.

   3. Как изменить основную миссию (положение и количество респаунов, доступные самолеты и вооружение и т.п.).
      Чтобы изменить высоту и положение стартовых точек-респаунов,а также доступные самолеты и вооружение отредактируйте файл миссии "host-channel.mis" в полном редакторе.  
      Скрипт загрузчика вызывается из файла скрипта основной миссии - "host-channel.cs".
      В файле "host-channel.mis" находятся только респауны для синих со всеми доступными самолетами на каждом и одиночный самолет Bf109E-3B для оффлайна - можете добавить в миссию свои респауны, самолеты или другие обЪекты.
      Вы можете добавить в папку "MissionLoader" свой файл основной миссии с условием, что будет создана копия скрипта "host-channel.cs" в папке загрузчика с именем, совпадающим с именем вашей миссии.

   4. Как добавить свои миссии в сборку.
      Поместите свою миссию либо в одну из существующих папок в сборке либо создайте свою. Название папки и название файла миссии станет пунктом меню в игре. 


==============================================================================
   * Структура файлов и папок *
______________________________________________________________________________
      В главной папке загрузчика(missions\MissionLoader\MissionPack) находятся папки, в которые помещены сборки миссий - миссион-паки (Mission pack). 
      Ограничений на количество папок и файлов нет. 
      Ограничений на их названия также нет.
      Имя папки является названием пункта меню.
      Миссии читаются только из миссион-паков и только там должны находиться.

      Чтобы было проще представить: файлы миссий - это страницы. Миссион-паки - это книги. А папки, в которых хранятся миссион паки - книжные полки. Сам MissionLoader - это шкаф. Для примера - см. стандартные миссии.
      П.С. Прости меня Боже за такое ридми :)


==============================================================================
   * Настройка параметров загружаемых миссий *
______________________________________________________________________________       			
      Вы можете создать текстовый файл .txt в кодировке UTF-8 для задания индивидуальных параметров каждой миссии, при этом его название должно совпадать с названием файла миссии. В начале файла в первых восьми строчках прописано название пункта меню на всех языках, при выборе которого будет вызываться загрузка миссии - например "Начать битву!" вместо "Start Battle.mis" по умолчанию.



    -------------------------------------------------------------------------
      =Формат файла параметров миссии=
    -------------------------------------------------------------------------
№ 
строки

01         4xBf110 attack - 3min      //en Название пункта меню на английском
02         Отправить в атаку 4xBf110  //ru  ..на русском
03         Tommi Kaput                //de  ..на немецком
04         4xBf110 attack - 3min      //fr
05         4xBf110 attack - 3min      //es
06         4xBf110 attack - 3min      //cs
07         4xBf110 attack - 3min      //it
08         4xBf110 attack - 3min      //pl
09         2                          //количество доступных загрузок миссии
    -------------------------------------------------------------------------
      
      Следующий параметр (строка номер 9) - количество доступных загрузок миссии. Для миссий со статическими объектами лучше ставить 1, для остальных ориентируйтесь на производительность компьютера.
      ПРИМЕЧАНИЕ: Соблюдайте структуру файла и формат параметров, чтобы избежать ошибок скрипта.

      Также вы можете назначить принадлежность миссии одной из сторон, пилоты которой смогут загружать миссию (у игроков другой стороны ее не будет в меню). Для этого в начале имени файла миссии добавьте приставку "red_" или "blue_". Миссия без приставки будет доступна для всех.
      ПРИМЕЧАНИЕ: Скрипт рассчитан на использование только двух сторон - синие(blue) и красные(red).

      =Параметры по умолчанию, которые используются если миссия не имеет одноименного txt-файла:=
      ------------------------------------------
   -  название пункта меню - имя файла миссии (например "Ju87 attack - 3min.mis")
   -  миссия доступна для загрузки всем игрокам, независимо от стороны (красные или синие)
   -  миссию можно загрузить только один раз


==============================================================================
   * Настройка параметров загрузчика в файле setup.txt *
______________________________________________________________________________
      Файл setup.txt находится в папке "MissionLoader/System" и содержит параметры для тонкой настройки загрузчика.


    -------------------------------------------------------------------------
      =Формат файла setup.txt=
    -------------------------------------------------------------------------
№ 
строки

01         Mission Loader Menu      //Название пункта меню загрузчика
02         1                        //Настройка варианта сообщений сервера о загрузке миссии
02         auto                     //Выбор языка вывода сообщений
04         1                        //Включает/выключает чтение название пункта меню из .txt-файла
05         1                        //Включает/выключает режим создания меню в зависимости от армии игрока (1 - включено, 0 - выключено)
    --------------------------------------------------------------------------

      Параметр в первой строке - название пункта меню для входа в меню загрузчика. Вы можете изменить его.

      Параметр во второй строке - вариант сообщений сервера о загрузке миссии(1 - только имя файла миссии, 2 - полный путь к файлу миссии).

      Параметр в третьей строке - выбор языка вывода сообщений. Может принимать следующие значения:
        auto - язык вывода сообщений определяется автоматически в зависимости от версии игры
          en
          ru
          de
          fr
          es
          cs
          it
          pl

      Параметр в четвертой строке - включает/выключает чтение название пункта меню из .txt-файла, независимо от его наличия в папке с миссиями. Предназначено для увеличения производительности (1 - включено, 0 - выключено)

      Параметр в пятой строке - включает/выключает режим создания меню в зависимости от армии игрока (1 - включено, 0 - выключено). Миссии предназначенные для игроков стороны "Синие" будут доступны для игроков стороны "Красные" и наоборот.


==============================================================================
   * Описание работы загрузчика *
______________________________________________________________________________
      Файл скрипта находится здесь: missions\MissionLoader\System\missionloader.cs
      Сначала запускается миссия "host-channel.mis", которая вызывает скрипт загрузчика.
      При выборе в меню <"Tab" + "4" +"1"> скрипт считывает папки из "missions\MissionLoader\MissionPack" и строит из них первый уровень меню. Название папки становится пунктом меню. Если папка содержит миссион-паки - цвет пункта меню желтый. Если папка пуста - цвет пункта меню красный и при выборе этого пункта выдается сообщение о том, что выбранная папка пуста.
      Далее если выбрать пункт меню мы попадаем на второй уровень меню со списком миссион паков. Название папки миссион-пака становится пунктом меню. Если миссион-пак содержит миссии - цвет пункта меню желтый. Если папка пуста - цвет пункта меню красный и при выборе этого пункта выдается сообщение о том, что выбранный миссион-пак не содержит миссии.
      Если в меню выбрать какой-нибудь миссион-пак мы попадаем на третий уровень меню со списком миссий, которые уже непосредственно можем загрузить. Перед названием миссии отображается символ "*". Цвет пункта меню с названием миссии всегда красный. О загрузке миссии выводится сообщение.
      Если на странице меню более 9 элементов - оно разбивается на несколько страниц, перемещение между которыми осуществляется при помощи пунктов ">>> Next Page" и "<<< Previous Page".  
  
      Скрипт при перемещении по меню постоянно обращается к диску, составляя списки папок и файлов, поэтому если будут проблемы с производительностью связанный с жестким диском - используйте параметры в файле setup.txt для уменьшения количества обращений к файлам.


==============================================================================
   * Credits *
______________________________________________________________________________   
   1. naryv and Small_Bee for the help in the my script-work.
   2. FG28_Kodiak for useful information on forums and excellent scripts.
   3. Ataros(Atas) for mission pack "Fighter Training". 
   4. KDN for mission pack "KDN Pack".

      Thanks!

==============================================================================
   * Links *
______________________________________________________________________________

   1. http://www.sukhoi.ru/forum/showthread.php?t=72909&p=1744303#post1744303
   2. http://forum.1cpublishing.eu/showthread.php?t=28056

==============================================================================
   * Author and Copyright *
______________________________________________________________________________

      Alexey "podvoxx" Schwab
      podvoxx@yahoo.com

      Вы можете модифицировать скрипт и использовать измененный MissionLoader в ваших проектах в некоммерческих целях. Все права на миссии принадлежат авторам миссий.




==============================================================================
                             * Version History *
______________________________________________________________________________


vvv----------------------------Версия 1.15 - 17.12.11----------------------vvv

   1. Введена локализация сообщений. Теперь сообщения отображаются на языке игрока.
   2. Введена локализация пунктов меню, описанных в txt-файле.
   3. Добавлена возможность отображать в меню миссии в зависимости от стороны игрока - "Синие" или "Красные". Функция отключается в настройках. 
   4. Добавлена возможность отключения чтения названий пунктов меню из txt-файла. 
   5. Миссии в меню теперь помечаются символом "*" перед названием пункта меню.
   6. Снято ограничение на количество пунктов меню. Теперь папок и файлов может быть сколь угодно много - меню будет разбито на страницы. 
   7. Добавлено readme на русском и английском. В папке "Readme" загрузчика есть также примеры файлов настройки с комментариями и тестовый набор миссион-паков(не для игры, только чтобы увидеть возможности навигации по меню).
   8. Добавлено 60 новых миссий от KDN. Спасибо ему!
   9. Скорректирована миссия "Attack The Village" - теперь некоторые подкрепления можно вызывать несколько раз.
  
^^^------------------------------------------------------------------------^^^


vvv----------------------------Версия 1.10 - 04.12.11----------------------vvv

   1. Теперь не обязательно прописывать название пунктов меню - если текстовый файл отсутствует - названием пункта меню будет имя файла.
   2. Убрал из сборки полностью русский язык, так как не успеваю делать две версии, а локализацию еще не встроил.
   3. Добавлен пак тренировочных миссий для истребителя от Атаса "Default 3 - Fighter Training" за что ему низкий поклон и человеческое спасибо .
   4. Переработана структура папок.
   5. Теперь, если поставить в начале имени файла или папки тире - она/он не будет отображаться как пункт меню. Это позволит держать в папке загрузчика неограниченное количество файлов и папок без копирования в другие директории.
   6. Добавлен пак миссий с масштабным сражением за французскую деревушку - "Default 2 - Attack The Village". Впервые игроку дана возможность не только самому воевать, но и вызывать подкрепления и давать приказ наземным войсками на начало атаки. Подробнее см. первый пост темы.
   7. Ридми временно устранен из сборки для приведения в божеский вид, вся информация пока на форуме.

^^^------------------------------------------------------------------------^^^


vvv----------------------------Версия 1.05 - 25.11.11----------------------vvv

   1. Добавлено автоматическое определение пути к миссиям скриптом загрузчика, теперь не нужно его прописывать самостоятельно.
   2. Теперь для запуска онлайн и сингл миссий используется один и тот же файл, вместо двух как было в первой версии.
   3. Мелкие изменения в структуре папок.
   4. Путь к миссиям стал короче, загрузчик лежит теперь по адресу X:\...\Documents\1C SoftClub\il-2 sturmovik cliffs of dover\missions\

^^^------------------------------------------------------------------------^^^